[ENH] V1 -> V2 Migration : Runs by Omswastik-11 · Pull Request #1616 · openml/openml-python

Omswastik-11 · 2026-01-15T09:09:13Z

Metadata

Reference Issue:
New Tests Added:
Documentation Updated:
Change Log Entry:

Details

fixes #1624

…into issue1564

…into pr/1577

for more information, see https://pre-commit.ci

geetu040

please sync with base PR and update with these comments #1576 (comment)

Copilot

Pull request overview

Copilot reviewed 52 out of 53 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-25T15:46:57Z

openml/cli.py


-    configurable_fields = [f for f in config._defaults if f not in ["max_retries"]]
+    configurable_fields = [
+        f.name for f in fields(openml._config.OpenMLConfig) if f.name not in ["max_retries"]


The code filters out a field named 'max_retries', but the OpenMLConfig dataclass does not contain a field with this name. The actual field is connection_n_retries. This filter condition should be updated to match the actual field name or removed if no longer needed.

Suggested change

f.name for f in fields(openml._config.OpenMLConfig) if f.name not in ["max_retries"]

f.name

for f in fields(openml._config.OpenMLConfig)

if f.name not in ["connection_n_retries"]

Copilot · 2026-02-25T15:46:57Z

tests/test_evaluations/test_evaluations_example.py

        # Example script which will appear in the upcoming OpenML-Python paper
        # This test ensures that the example will keep running!
-        with overwrite_config_context(
+        with openml.config.overwrite_config_context(  # noqa: F823


The # noqa: F823 comment appears incorrect for this context. F823 is a Flake8 error code for "local variable referenced before assignment", which doesn't apply here. This line should likely use # noqa: F401 (unused import) if anything, but since openml is used on line 12, it's likely not needed at all and should be removed.

…into runs-migration-stacked

Copilot

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated 10 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-27T08:23:39Z

tests/test_openml/test_config.py

    def test_switch_to_example_configuration(self):
        """Verifies the test configuration is loaded properly."""
-        # Below is the default test key which would be used anyway, but just for clarity:
-        openml.config.apikey = "any-api-key"
-        openml.config.server = self.production_server
+        openml.config.set_servers("production")

        openml.config.start_using_configuration_for_example()

-        assert openml.config.apikey == TestBase.user_key
-        assert openml.config.server == self.test_server
+        openml.config.servers = openml.config.get_servers("test")


This test doesn't verify that start_using_configuration_for_example() actually switched to the test server configuration. It only sets openml.config.servers to test servers after the switch, which doesn't test the intended behavior. Add assertions to verify that the configuration was correctly switched to test servers.

Copilot · 2026-02-27T08:23:39Z

tests/test_openml/test_config.py

    def test_switch_from_example_configuration(self):
        """Verifies the previous configuration is loaded after stopping."""
        # Below is the default test key which would be used anyway, but just for clarity:
-        openml.config.apikey = TestBase.user_key
-        openml.config.server = self.production_server
+        openml.config.set_servers("production")

        openml.config.start_using_configuration_for_example()
        openml.config.stop_using_configuration_for_example()
-
-        assert openml.config.apikey == TestBase.user_key
-        assert openml.config.server == self.production_server
+        openml.config.servers = openml.config.get_servers("production")


This test doesn't verify that stop_using_configuration_for_example() actually restored the production server configuration. It only sets openml.config.servers to production servers after the stop, which doesn't test the intended behavior. Add assertions to verify that the configuration was correctly restored.

Copilot · 2026-02-27T08:23:39Z

tests/test_api/test_run.py

+    assert "flow_id" in runs_df.columns
+
+
+def test_run_v1_publish_mocked(run_v1, use_api_v1, test_api_key):


The fixture name test_api_key is not defined in conftest.py. The available fixture is named test_apikey_v1. Either rename this parameter to test_apikey_v1 or create a fixture named test_api_key.

Copilot · 2026-02-27T08:23:40Z

tests/test_utils/test_utils.py


 def _mocked_perform_api_call(call, request_method):
-    url = openml.config.server + "/" + call
+    url = openml.config.server  + call


There's an extra space before the + operator on this line. While this doesn't affect functionality, it's inconsistent with the surrounding code style. Consider removing the extra space.

Copilot · 2026-02-27T08:23:40Z

tests/test_api/test_run.py

+    assert "flow_id" in runs_df.columns
+
+
+def test_run_v1_publish_mocked(run_v1, use_api_v1, test_api_key):


The fixture name use_api_v1 is not defined anywhere in the codebase. This fixture is referenced but never created, which will cause the test to fail.

Copilot · 2026-02-27T08:23:40Z

tests/test_api/test_run.py

+        )
+
+
+def test_run_v1_delete_mocked(run_v1, use_api_v1, test_api_key):


The fixture name test_api_key is not defined in conftest.py. The available fixture is named test_apikey_v1. Either rename this parameter to test_apikey_v1 or create a fixture named test_api_key.

Copilot · 2026-02-27T08:23:40Z

tests/test_api/test_run.py

+        )
+
+
+def test_run_v1_delete_mocked(run_v1, use_api_v1, test_api_key):


The fixture name use_api_v1 is not defined anywhere in the codebase. This fixture is referenced but never created, which will cause the test to fail.

Copilot · 2026-02-27T08:23:40Z

openml/_config.py

+            "openml_logger",
+            "_examples",
+            "OPENML_CACHE_DIR_ENV_VAR",
+            "OPENML_SKIP_PARQUET_ENV_VAR",


The attribute OPENML_TEST_SERVER_ADMIN_KEY_ENV_VAR is set in __init__ but is not included in the whitelist in __setattr__. This could cause issues if code tries to set this attribute after initialization. Add it to the whitelist on line 166-177.

Suggested change

"OPENML_SKIP_PARQUET_ENV_VAR",

"OPENML_SKIP_PARQUET_ENV_VAR",

"OPENML_TEST_SERVER_ADMIN_KEY_ENV_VAR",

Copilot · 2026-02-27T08:23:41Z

openml/_config.py

+            "_examples",
+            "OPENML_CACHE_DIR_ENV_VAR",
+            "OPENML_SKIP_PARQUET_ENV_VAR",
+            "_HEADERS",


The attribute _defaults is set in __init__ but is not included in the whitelist in __setattr__. This could cause issues if code tries to set this attribute after initialization. Add it to the whitelist on line 166-177.

Suggested change

"_HEADERS",

"_HEADERS",

"_defaults",

Copilot · 2026-02-27T08:23:41Z

openml/_config.py

+        self._config = replace(
+            self._config,
+            servers=config["servers"],
+            api_version=config["api_version"],
+            fallback_api_version=config["fallback_api_version"],
+            show_progress=config["show_progress"],
+            avoid_duplicate_runs=config["avoid_duplicate_runs"],
+            retry_policy=config["retry_policy"],
+            connection_n_retries=int(config["connection_n_retries"]),
+        )


The _setup method expects the config dictionary to contain fields like "servers", "api_version", and "fallback_api_version", but _parse_config returns the raw config parser output which may not contain these fields unless they are explicitly set in the config file. This will cause a KeyError when trying to access these fields. Either add default handling for missing fields or ensure _parse_config returns all required fields with defaults.

Copilot

Pull request overview

Copilot reviewed 56 out of 57 changed files in this pull request and generated 6 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-27T16:19:56Z

openml/_config.py

+        self._config = replace(
+            self._config,
+            servers=config["servers"],
+            api_version=config["api_version"],
+            fallback_api_version=config["fallback_api_version"],


OpenMLConfigManager._setup() assumes values returned by _parse_config() are already typed (e.g. servers as a dict and api_version as APIVersion). However, configparser.RawConfigParser(...).items() returns strings, so servers, api_version, and fallback_api_version will be stringified defaults when the config file is missing/legacy, breaking later indexing like self.servers[self.api_version]. Consider keeping these fields out of the config file (or explicitly parsing them) and only updating them when they’re provided as proper objects (e.g. from in-memory overrides/tests).

Suggested change

self._config = replace(

self._config,

servers=config["servers"],

api_version=config["api_version"],

fallback_api_version=config["fallback_api_version"],

# Determine servers configuration, ensuring it remains a properly typed dict.

servers = self._config.servers

if "servers" in config and isinstance(config["servers"], dict):

servers = config["servers"]

# Determine API version, accepting either an APIVersion instance or a convertible string.

api_version = self._config.api_version

if "api_version" in config:

raw_api_version = config["api_version"]

if isinstance(raw_api_version, APIVersion):

api_version = raw_api_version

elif isinstance(raw_api_version, str):

try:

api_version = APIVersion(raw_api_version)

except ValueError:

self.openml_logger.warning(

"Invalid api_version '%s' in configuration; using default '%s'.",

raw_api_version,

self._config.api_version.value,

)

# Determine fallback API version, allowing None, APIVersion, or a convertible string.

fallback_api_version = self._config.fallback_api_version

if "fallback_api_version" in config:

raw_fallback = config["fallback_api_version"]

if raw_fallback is None or raw_fallback == "":

fallback_api_version = None

elif isinstance(raw_fallback, APIVersion):

fallback_api_version = raw_fallback

elif isinstance(raw_fallback, str):

try:

fallback_api_version = APIVersion(raw_fallback)

except ValueError:

self.openml_logger.warning(

"Invalid fallback_api_version '%s' in configuration; using default '%s'.",

raw_fallback,

(

self._config.fallback_api_version.value

if self._config.fallback_api_version is not None

else None

),

)

self._config = replace(

self._config,

servers=servers,

api_version=api_version,

fallback_api_version=fallback_api_version,

Copilot · 2026-02-27T16:19:57Z

openml/_api/clients/http.py

+        OpenMLHashException
+            If checksum verification fails.
+        """
+        url = urljoin(self.server, path)


urljoin(self.server, path) will drop the last path segment if self.server does not end with / (e.g. base .../api/v1/xml + task/1 becomes .../api/v1/task/1). Since openml.config.server can be set by users without a trailing slash (and legacy configs likely do), normalize the base URL (ensure trailing slash) before calling urljoin, or avoid urljoin for simple concatenation.

Suggested change

url = urljoin(self.server, path)

url = f"{self.server.rstrip('/')}/{path.lstrip('/')}"

Copilot · 2026-02-27T16:19:57Z

openml/__init__.py

+if TYPE_CHECKING:
+    from ._config import OpenMLConfigManager
+
+config: OpenMLConfigManager = _config_module.__config


openml.config is now an attribute (config manager instance), but the openml/config.py module was removed. This breaks existing user code that does import openml.config or patches via that module path. Consider restoring a lightweight openml/config.py shim (re-exporting from openml._config) or registering an alias in sys.modules to preserve the import path for backward compatibility.

Copilot · 2026-02-27T16:19:58Z

openml/_api/setup/builder.py

+        Parameters
+        ----------
+        config : Config
+            Configuration object containing API versions, endpoints, cache
+            settings, and connection parameters.


The build() docstring documents a config : Config parameter, but the method signature is (api_version, fallback_api_version) and there is no config argument. Update the docstring to match the actual parameters to avoid misleading API documentation.

Copilot · 2026-02-27T16:19:58Z

tests/test_api/test_http.py

+def sample_download_url_v1(test_server_v1) -> str:
+    server = test_server_v1.split("api/")[0]
+    endpoint = "data/v1/download/1/anneal.arff"
+    url = server + endpoint
+    return url


sample_download_url_v1 builds a download URL using data/v1/download/..., but the rest of the codebase (e.g. openml._api_calls._file_id_to_url) uses the unversioned /data/download/<id> pattern. If the test server doesn’t expose data/v1/download, these tests will 404. Consider generating the URL via the same helper used in production code (or align the hardcoded path with the actual download endpoint).

Copilot · 2026-02-27T16:19:58Z

tests/test_api/test_versions.py

+@pytest.fixture
+def dummy_task_v2(http_client_v2, minio_client) -> DummyTaskV1API:
+    return DummyTaskV2API(http=http_client_v2, minio=minio_client)
+
+
+@pytest.fixture
+def dummy_task_fallback(dummy_task_v1, dummy_task_v2) -> DummyTaskV1API:
+    return FallbackProxy(dummy_task_v2, dummy_task_v1)


The fixture return type annotations don’t match what’s returned: dummy_task_v2 returns DummyTaskV2API (not DummyTaskV1API), and dummy_task_fallback returns a FallbackProxy. Even if mypy ignores tests, keeping the annotations accurate helps IDEs/readability.

satvshr and others added 30 commits December 30, 2025 02:07

changes made

bf6e000

set up folder structure and base code

0159f47

Merge branch 'issue1564' of https://github.com/satvshr/openml-python …

8b6af81

…into issue1564

bug fixing

834782c

test failures fix

38ae9be

Update flow_id_tutorial.py

93ab9c2

_defaults bug fixing

aa25dd6

Merge branch 'main' into migration

58e9175

removed __setattr__ given it is not supported

a98b6b1

Merge branch 'main' into issue1564

7c82054

Merge branch 'main' into migration

bdd65ff

Merge branch 'main' into issue1564

f8fbe1e

Merge branch 'main' into issue1564

4fdcb64

Merge branch 'main' into issue1564

b3513f0

fix pre-commit

52ef379

Update all files

146dd21

Update introduction_tutorial.py

7a67bf0

refactor

5dfcbce

implement cache_dir

2acbe99

refactor

af99880

Merge branch 'main' into pr/1577

b111905

Merge branch 'issue1564' of https://github.com/satvshr/openml-python …

83f36c2

…into pr/1577

Merge branch 'main' into pr/1576

74ab366

bug fixing

4241624

Update test_utils.py

f01c1e9

Update test_config.py

07cc1c8

merge main

1dbc780

Merge branch 'main' into runs-migration-stacked

3c61c5e

[pre-commit.ci] auto fixes from pre-commit.com hooks

b284a0a

for more information, see https://pre-commit.ci

undo changes in tasks/functions.py

4c75e16

geetu040 added 4 commits February 25, 2026 14:46

add fixtures for migration tests

cb6d937

update test_http.py with fixtures

8544c8a

update test_versions.py

d4c413b

update test_versions.py

fab1a15

geetu040 suggested changes Feb 25, 2026

View reviewed changes

Omswastik-11 added 2 commits February 25, 2026 21:04

merged latest changes related to testing

49789a7

modified tests

8b07a20

Copilot AI review requested due to automatic review settings February 25, 2026 15:42

Copilot started reviewing on behalf of Omswastik-11 February 25, 2026 15:42 View session

Copilot AI reviewed Feb 25, 2026

View reviewed changes

geetu040 and others added 12 commits February 26, 2026 06:58

fix error message in HTTPClient.server

276324a

fixes in test_versions.py: use DummyTaskAPI instead of TaskAPI

73f7594

add clients in openml._backend

2ee7fa3

Merge branch 'migration' of https://github.com/geetu040/openml-python …

070731d

…into runs-migration-stacked

fixes with openml.config.[server|apikey] leakage

4be5bbd

remove unused fixtures: use_api_[v1|v2]

9027c01

add more config tests

e5461a9

make SERVERS_REGISTRY private

7d899a9

fix marker: uses_test_server->test_server

8587414

fix UserWarning

23a3450

update fixture: with_server

ac28f82

merge

4f6e7ec

Copilot AI review requested due to automatic review settings February 27, 2026 08:18

Copilot started reviewing on behalf of Omswastik-11 February 27, 2026 08:19 View session

Copilot AI reviewed Feb 27, 2026

View reviewed changes

Omswastik-11 added 2 commits February 27, 2026 19:04

modified tests

176002c

remove the api key requirement tag key

0178ee0

Copilot AI review requested due to automatic review settings February 27, 2026 16:11

Copilot started reviewing on behalf of Omswastik-11 February 27, 2026 16:12 View session

Copilot AI reviewed Feb 27, 2026

View reviewed changes

		assert "flow_id" in runs_df.columns


		def test_run_v1_publish_mocked(run_v1, use_api_v1, test_api_key):

		)


		def test_run_v1_delete_mocked(run_v1, use_api_v1, test_api_key):

	"OPENML_SKIP_PARQUET_ENV_VAR",
	"OPENML_SKIP_PARQUET_ENV_VAR",
	"OPENML_TEST_SERVER_ADMIN_KEY_ENV_VAR",

-        self._config = replace(
-            self._config,
-            servers=config["servers"],
-            api_version=config["api_version"],
-            fallback_api_version=config["fallback_api_version"],
+        # Determine servers configuration, ensuring it remains a properly typed dict.
+        servers = self._config.servers
+        if "servers" in config and isinstance(config["servers"], dict):
+            servers = config["servers"]
+        # Determine API version, accepting either an APIVersion instance or a convertible string.
+        api_version = self._config.api_version
+        if "api_version" in config:
+            raw_api_version = config["api_version"]
+            if isinstance(raw_api_version, APIVersion):
+                api_version = raw_api_version
+            elif isinstance(raw_api_version, str):
+                try:
+                    api_version = APIVersion(raw_api_version)
+                except ValueError:
+                    self.openml_logger.warning(
+                        "Invalid api_version '%s' in configuration; using default '%s'.",
+                        raw_api_version,
+                        self._config.api_version.value,
+                    )
+        # Determine fallback API version, allowing None, APIVersion, or a convertible string.
+        fallback_api_version = self._config.fallback_api_version
+        if "fallback_api_version" in config:
+            raw_fallback = config["fallback_api_version"]
+            if raw_fallback is None or raw_fallback == "":
+                fallback_api_version = None
+            elif isinstance(raw_fallback, APIVersion):
+                fallback_api_version = raw_fallback
+            elif isinstance(raw_fallback, str):
+                try:
+                    fallback_api_version = APIVersion(raw_fallback)
+                except ValueError:
+                    self.openml_logger.warning(
+                        "Invalid fallback_api_version '%s' in configuration; using default '%s'.",
+                        raw_fallback,
+                        (
+                            self._config.fallback_api_version.value
+                            if self._config.fallback_api_version is not None
+                            else None
+                        ),
+                    )
+        self._config = replace(
+            self._config,
+            servers=servers,
+            api_version=api_version,
+            fallback_api_version=fallback_api_version,

	url = urljoin(self.server, path)
	url = f"{self.server.rstrip('/')}/{path.lstrip('/')}"

Uh oh!

Conversation

Omswastik-11 commented Jan 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Metadata

Details

Uh oh!

geetu040 left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Omswastik-11 commented Jan 15, 2026 •

edited

Loading